NOTE:
List of Allocation Rule objects; list contains the following parameters: start, count and total number of Allocation Rule objects
List Allocation Rule Object
Long id - Allocation Rule Id
String name - Allocation Rule Name
Long id_partition - Partition Id
Integer mode - Rule disabled flag (0 - active, 2 - disabled)
String monday - Time period during which the given rule is valid or activated. Time schedule mask for Monday, string containing 24 digits, each corresponding to one hour, starting from 00 to 23 h ('1' if Rule is active in both half of hour, '2' only in the first half, '3' only in the second half or '0' if Rule is deactivated in both half of hour)
String tuesday - Time period during which the given rule is valid or activated. Time schedule mask for Tuesday, string containing 24 digits, each corresponding to one hour, starting from 00 to 23 h ('1' if Rule is active in both half of hour, '2' only in the first half, '3' only in the second half or '0' if Rule is deactivated in both half of hour)
String wednesday - Time period during which the given rule is valid or activated. Time schedule mask for Wednesday, string containing 24 digits, each corresponding to one hour, starting from 00 to 23 h ('1' if Rule is active in both half of hour, '2' only in the first half, '3' only in the second half or '0' if Rule is deactivated in both half of hour)
String thursday - Time period during which the given rule is valid or activated. Time schedule mask for Thursday, string containing 24 digits, each corresponding to one hour, starting from 00 to 23 h ('1' if Rule is active in both half of hour, '2' only in the first half, '3' only in the second half or '0' if Rule is deactivated in both half of hour)
String friday - Time period during which the given rule is valid or activated. Time schedule mask for Friday, string containing 24 digits, each corresponding to one hour, starting from 00 to 23 h ('1' if Rule is active in both half of hour, '2' only in the first half, '3' only in the second half or '0' if Rule is deactivated in both half of hour)
String saturday - Time period during which the given rule is valid or activated. Time schedule mask for Saturday, string containing 24 digits, each corresponding to one hour, starting from 00 to 23 h ('1' if Rule is active in both half of hour, '2' only in the first half, '3' only in the second half or '0' if Rule is deactivated in both half of hour)
String sunday - Time period during which the given rule is valid or activated. Time schedule mask for Sunday, string containing 24 digits, each corresponding to one hour, starting from 00 to 23 h ('1' if Rule is active in both half of hour, '2' only in the first half, '3' only in the second half or '0' if Rule is deactivated in both half of hour)
Long operator - GSM Network Operator PLMN (MCC+MNC) code; Only SIM cards of this provider are selected
Integer simmode - Sim choice mode (0 - Any SIM; Select SIM cards from specific provider, 1 - SIM group; Select SIM cards from specific SIM group, 2 - Price Plan; Select SIM cards from specific price plans, 3 - to be recharged; Select SIM cards without credit, i.e. requiring recharge, 4 - to be activated; SIM cards requiring an activation)
Integer simultaneous - RESERVED FOR FUTURE USAGE
Long simlease - Maximal lease time (seconds); Maximal time that will SIM card allocated by the given rule stay on the GSM port
Long callleasetime - Maximal calling time (seconds); Maximal calling time allowed on a SIM card before it will be deallocated
Integer priority - Priority level (1 to 9, 1 the highest priority); Allocation rules with lower priority are only applicable if those with higher priority have no SIM cards available for allocation
Integer port - RESERVED FOR FUTURE USAGE
Long simchoice - SIM preference (0 - Best credit; Select SIM card with the highest remaining credit, 2 - contract day; Select SIM card that is closest to the next recharge date, 3 - idle time; Select SIM card that is idle for the longest time, 4 - IRON Sim Rack; Select SIM card according to the physical location in IRON Sim Rack)
Long id_portgrp - Port Group Id; Only SIM cards from this Port group are selected
String portgrpname - Port Group name
Long id_simselect - Sim group Id / Price Plan Id; Only SIM cards from this Sim group or Price Plan are selected
Long maxcalls - Maximal number of calls; Maximal number of calls allowed on SIM card before it is deallocated
Integer conxcallonly - Connected calls only flag; Count only connected calls in MaxCalls
Integer forcereset - Force SIM deallocation; If checked, the allocated SIM card is deallocated by Sim Manager from GSM ports whenever it swaps from peak to off-peak period or vice-versa. Such deallocations are imposed even if SIM is used for the active call
Integer changemaster - Next allocation forced to another site; If checked SIM card is forbidden from being allocated twice consecutive to the GSM port on the same Gateway
Integer useoffpeak - Allocation call billing period; Determine if the billing increment of the given allocation rule is peak, off-peak or bonus value (0 - Call peak, 1 - Call off peak, 2 - Call bonus)
Long simsleep - Minimal sleeping/traveling time (seconds); The minimal time that the Sim Manager is forcing SIM card to stay unallocated in sleeping or traveling state, after it is deallocated from GSM port
Long countdown - Start SIM change in advance (seconds); Deallocate SIM cards ahead of their scheduled release time
Integer completelease - Force to complete time
Integer usereal - Callleasetime type, Billing or Real time (0 - Billing time, 1 - Real time)
Integer timezone - Time Zone Id; Time Zone for the times in Activated Period table (see Timezone table)
Integer smsallowed - Allocation route allowed for (0 - Call only, 1 - SMS only, 2 - Call & SMS)
Integer smsuseoffpeak - Allocation SMS billing period (0 - Call peak, 1 - Call off peak, 2 - Call bonus)
Integer status - / 4 - deactivated / 1 - activated / 0 - active but no sim use it
Integer callkeeppending -
Integer allowroaming -
Error Data structure ( Error Management )
Possible failure code returns
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
|
